پرش به مطلب اصلی

متد ارسال پیام

تمامی عملیات ارسال پیام در پلتفرم ما از طریق یک اندپوینت واحد انجام می‌شود. ساختار کلی درخواست‌ها ثابت است و شما تنها با تغییر پارامتر action و payload نوع سرویس را تعیین می‌کنید.

تنظیمات اتصال

متدآدرس پایه (Base URL)اندپوینت
POSThttps://gateway.ferzz.ir//send

هدرهای الزامی

نام هدر (Key)مقدار (Value)توضیحات
Content-Typeapplication/jsonالزامی. فرمت داده‌ها باید JSON باشد.

ساختار کلی بدنه

هر درخواست JSON شامل ۳ پارامتر ثابت و یک آبجکت متغیر (payload) است.

General Request Structure
{
"token": "YOUR_ACCESS_TOKEN",
"destination": "989123456789",
"action": "SERVICE_NAME",
"payload": {
// جزئیات اختصاصی هر سرویس در اینجا قرار می‌گیرد
}
}

جدول پارامترهای عمومی

پارامترنوعاجباریتوضیحات
tokenstringکلید دسترسی سرویس (دریافت از پنل).
destinationstringشماره موبایل (با ۹۸) یا ایمیل مقصد.
actionstringنوع سرویس (انتخاب از لیست زیر).
payloadobjectآبجکت حاوی دیتای سرویس.

سرویس‌ها

برای شروع، یکی از روش‌های احراز هویت زیر را انتخاب کنید تا مستندات مربوط به آن را ببینید:


پاسخ سرور

{
"status": 200,
"message": "Success",
"track_id": "cdd18c14-5ef8-407a-b2b0-d08877a718a7"
}
یادآوری

برای مشاهده لیست کامل کدهای خطا (4xx, 5xx) به صفحه کدهای وضعیت و خطاها مراجعه کنید.